/*

 * Licensed to the Apache Software Foundation (ASF) under one

 * or more contributor license agreements.  See the NOTICE file

 * distributed with this work for additional information

 * regarding copyright ownership.  The ASF licenses this file

 * to you under the Apache License, Version 2.0 (the

 * "License"); you may not use this file except in compliance

 * with the License.  You may obtain a copy of the License at

 *

 *     http://www.apache.org/licenses/LICENSE-2.0

 *

 * Unless required by applicable law or agreed to in writing, software

 * distributed under the License is distributed on an "AS IS" BASIS,

 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.

 * See the License for the specific language governing permissions and

 * limitations under the License.

 */

package com.bff.gaia.unified.sdk.extensions.sql;



import com.bff.gaia.unified.sdk.annotations.Experimental;

import com.bff.gaia.unified.sdk.values.Row;



import java.io.Serializable;

import java.util.List;



/**

 * A seekable table converts a JOIN operator to an inline lookup. It's triggered by {@code SELECT *

 * FROM FACT_TABLE JOIN LOOKUP_TABLE ON ...}.

 */

@Experimental

public interface UnifiedSqlSeekableTable extends Serializable {

  /** prepare the instance. */

  default void setUp() {};



  /** return a list of {@code Row} with given key set. */

  List<Row> seekRow(Row lookupSubRow);



  /** cleanup resources of the instance. */

  default void tearDown() {};

}